home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 028a / pkins700.zip / PKINSERT.DOC < prev    next >
Text File  |  1991-12-04  |  35KB  |  1,021 lines
  1.  
  2.  
  3.  
  4.  
  5.                    ┌───────────────────────────────────────┐
  6.                    │                                       │
  7.                    │                                       │
  8.                    │                                       │
  9.                    │                                       │
  10.                    │                                       │
  11.                    │                                       │
  12.                    │                                       │
  13.                    │                                       │
  14.                    │                                       │
  15.                    │                                       │
  16.                    │            P K I N S E R T            │
  17.                    │              Version 7.00             │
  18.                    │                                       │
  19.                    │   Copyright 7th Illusion, 1990-1991   │
  20.                    │          All Rights Reserved          │
  21.                    │      Released December 4th, 1991      │
  22.                    │                                       │
  23.                    │            F R E E W A R E            │
  24.                    │                                       │
  25.                    │                                       │
  26.                    │                                       │
  27.                    │                                       │
  28.                    │                                       │
  29.                    │                                       │
  30.                    │         Software Documentation        │
  31.                    │                                       │
  32.                    │                                       │
  33.                    │                                       │
  34.                    │                                       │
  35.                    │                                       │
  36.                    │                                       │
  37.                    │              7th Illusion             │
  38.                    │          Post Office Box 1334         │
  39.                    │               Station H               │
  40.                    │          Montreal QC, Canada          │
  41.                    │                H3G 2N6                │
  42.                    │                                       │
  43.                    │                                       │
  44.                    │         Node 1: (514)338-1193         │
  45.                    │        1:167/281.0@fidonet.org        │
  46.                    │    USRobotics Courier HST 14400 Bps   │
  47.                    │         2400 Bps to 14400 Bps         │
  48.                    │                                       │
  49.                    │         Node 2: (514)338-1680         │
  50.                    │        1:167/281.1@fidonet.org        │
  51.                    │          1200 Bps to 2400 Bps         │
  52.                    │                                       │
  53.                    │                                       │
  54.                    │                                       │
  55.                    │                                       │
  56.                    │                                       │
  57.                    │                                       │
  58.                    └───────────────────────────────────────┘
  59.  
  60.      
  61.  
  62.      PKInsert Software Documentation                          Page 1  of 16
  63.  
  64.  
  65.                                   Introduction
  66.  
  67.      PKInsert is  an archive manipulation  utility designed  for SysOps and
  68.      end users.  It may  be configured to test  archive integrity, scan for
  69.      viruses, insert and delete disclaimer files, and add archive comments.
  70.      Zip, Lzh, Arj, and Arj-Sfx type archives are supported.
  71.  
  72.      PKInsert is  fully network  compatible and when  used as  a Bbs upload
  73.      monitor, can create all the result files a SysOp may need.
  74.  
  75.      Released as Freeware, there's no need to register and all features are
  76.      active.   I'm  well  aware  of the  eternal  struggle  SysOps  face in
  77.      registering just a small portion of  the software they use.  :-)  I'll
  78.      answer questions and work in most  features you suggest, just drop off
  79.      a message on my system (long-distance callback validation available).
  80.  
  81.      If  you use  PKInsert and  have  authored SysOp  or Telecommunications
  82.      oriented software,  I would  appreciate if you  uploaded me  a copy in
  83.      return.  Please don't bother with Crippleware.
  84.  
  85.      Supplemental  information  on  installing  PKInsert  with  PCBoard  is
  86.      available from the PKInsPCB.Doc file.
  87.  
  88.      PKInsert was written in QuickBASIC  V4.5 on a 386-33mhz IBM Compatible
  89.      running under  DESQview V2.41,  QEMM V6.02,  Microsoft DOS  V3.30, and
  90.      Norton Utilities 5.0 Small Disk Cache.
  91.  
  92.  
  93.                                                       J.S. Morisset
  94.                                                       aka Storm Widow
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.      
  121.  
  122.      PKInsert Software Documentation                          Page 2  of 16
  123.  
  124.  
  125.                                 Acknowledgements
  126.  
  127.      The  following  names are  either  trademarks,  registered trademarks,
  128.      and/or efforts of the person and/or company named.
  129.  
  130.      PCBoard            Clark Development Company
  131.      Pkzip/Pkunzip      PKWare Inc.
  132.      Lha                Haruyasu Yoshizaki
  133.      Arj                Robert K. Jung
  134.      SCAN               McAfee Associates
  135.      DESQview/QEMM      Quarterdeck
  136.  
  137.      The terms Arc, Archive, Unarc, Etc. are used throughout this document.
  138.      THEY  ARE  CONSIDERED GENERIC  TERMS  FOR  ZIP, LZH,  AND  ARJ ARCHIVE
  139.      FORMATS.
  140.  
  141.                                   Requirements
  142.  
  143.      PKInsert  will  not  load  unless  you  have  the  following  software
  144.      available  from  a PATHed  directory.   The versions  shown  are those
  145.      tested with PKInsert at the time of it's release.
  146.  
  147.      PKZIP/UNZIP.EXE    Version 1.10
  148.      LZH.EXE            Version 2.13
  149.      ARJ.EXE            Version 2.22
  150.      SCAN.EXE           Version 7.9V84 (Optional)
  151.  
  152.                                    Upgrading
  153.  
  154.      **********************************************************************
  155.      WARNING:  PKInsert V7.00 will NOT read or convert configuration files
  156.      of older versions!  Although this makes upgrading a bit longer, it
  157.      saves on code size.
  158.      **********************************************************************
  159.  
  160.      Please review  the PKInsHis.Doc file  for details on  new features and
  161.      bug fixes.
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.      
  181.  
  182.      PKInsert Software Documentation                          Page 3  of 16
  183.  
  184.  
  185.                               PKInsert Parameters
  186.  
  187.      Parameters  may  be  entered  from  the  command  line  or environment
  188.      variable.   Environment   parameters  will  over-ride   those  of  the
  189.      configuration file, and  command line parameters  will over-ride those
  190.      of the environment.  Parameters are not case sensitive.
  191.  
  192.      Parameter
  193.  
  194.      /C       Marks  PKInserts  configuration  file  name  and  path.  This
  195.               variable must be  present in the  environment or command line
  196.               for PKInsert to load successfully.
  197.  
  198.                    ie.  /cD:\Arc\PKInsert\PKInsert.cfg
  199.  
  200.      /D       Pcboard  upload  description  file name  and  path.   Used to
  201.               document test failures.  (optional)
  202.  
  203.                    ie.  /dD:\Pcb\Work\Uldesc.1
  204.                         /d%3
  205.  
  206.      /N       Network node  number.  Maximum length  of three alpha-numeric
  207.               characters.  (optional)
  208.  
  209.                    ie.  /n1A
  210.  
  211.      /S       Version of Scan  you are currently  using.  Maximum length of
  212.               six alpha-numeric characters.  (optional)
  213.  
  214.                    ie.  /s7.9V84
  215.  
  216.      /CONFIG  Load PKInserts configuration module.
  217.  
  218.                    ie.  PKINSERT.EXE /cPKInsert.Cfg /CONFIG
  219.  
  220.      /TEST    Re-test  an  archive  (used  on  Bulletin  Boards).   Affects
  221.               verbose log file results when a virus is located.  (optional)
  222.  
  223.                    ie.  PKINSERT.EXE /TEST %1
  224.  
  225.      /UPLOAD  Process an upload (used on Bulletin Boards).  Affects verbose
  226.               log file results when a virus is located.  (optional)
  227.  
  228.                    ie.  PKINSERT.EXE /UPLOAD %1
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.      
  241.  
  242.      PKInsert Software Documentation                          Page 4  of 16
  243.  
  244.  
  245.                               Configuration Module
  246.  
  247.      To configure PKInsert for the first time, follow this first example.
  248.  
  249.               PKINSERT.EXE /CONFIG /cC:\PKInsert\PKInsert.Cfg
  250.  
  251.      PKInsert will ask you to verify the path and name of the configuration
  252.      file to create.  Pressing the (Esc) key will get you back to Dos.
  253.  
  254.      Note -   It  is  possible  to  use  a  single  configuration  file for
  255.               multiple users/work stations.
  256.  
  257.               Default  configuration  values may  differ  based  on initial
  258.               drive and directory locations.
  259.  
  260.      From the main configuration menu you will have three choices available
  261.      to you.  We will start from the  first and explain every item as we go
  262.      along.  All standard editing keys are active.
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.      
  301.  
  302.      PKInsert Software Documentation                          Page 5  of 16
  303.  
  304.  
  305.      ╔════════════════════════════════════════════════════════════════════╗
  306.      ║                            Options Menu                            ║
  307.      ║                                                                    ║
  308.      ║   Xtract/Temp Files Drive : C      Insert Archive Comment  : N     ║
  309.      ║   Req Xtract Space (%Arc) : 250    Delete Disclaimer(s)    : N     ║
  310.      ║                                    Add File(s) to Archive  : N     ║
  311.      ║   Rename Bad/Virused Arcs : Y                                      ║
  312.      ║   Held Archive Rename Ext : HLD    Manage Pass/Fail Log    : N     ║
  313.      ║                                    Keep Result/Error Log   : Y     ║
  314.      ║   Test Archive CRC        : Y      Max. Standard Log Size  : 80    ║
  315.      ║   Corrupt Arc Rename Ext  : BAD                                    ║
  316.      ║                                    Nested Arc Array Size   : 3     ║
  317.      ║   Scan Archives for Virii : N      Arc Wildcard Array Size : 60    ║
  318.      ║   Virused Arc Rename Ext  : VIR                                    ║
  319.      ║   McAfee Assoc. SCAN Ver  : 0.0V00                                 ║
  320.      ║                                                                    ║
  321.      ║   Number Taglines to Keep : 10                                     ║
  322.      ║   Identification Tagline?                                          ║
  323.      ║   Generic Tagline                                                  ║
  324.      ║                                                                    ║
  325.      ╚═══ 12/04/91 ════════════════════════════════════════ 07:00:00am ═══╝
  326.  
  327.  
  328.                             Xtract/Temp Files Drive
  329.  
  330.      Enter  the  drive  letter where  PKInsert  will  extract  archives for
  331.      testing and virus scanning.  I strongly suggest using a ram-disk which
  332.      improves PKInserts performance dramatically.
  333.  
  334.                             Req Xtract Space (%Arc)
  335.  
  336.      PKInsert  will  check  for  available  disk  space  before  extracting
  337.      archives.   This value  is not  calculated  like tax  - 250%  would be
  338.      translated to 2.5 times the size of the archive.  If PKInsert runs out
  339.      of disk space  during processing, it  will rename the  archive or exit
  340.      with an error level.
  341.  
  342.      Disk space  errors are  also reported  during archive  extraction, but
  343.      verifying disk space before-hand saves time.
  344.  
  345.                             Rename Bad/Virused Arcs
  346.  
  347.      This encompasses more than just file naming.  If this option is set to
  348.      (Y)es  PKInsert will  rename archives  using  the file  extensions you
  349.      enter  bellow.   It also  assumes  you  are processing  archives  on a
  350.      wildcard  such as  (*.Arc).  When  PKInsert runs  across a  virused or
  351.      corrupt archive it will rename it and continue to the next file in the
  352.      batch.  This  method is  not very  selective -  Any error  reported by
  353.      Pkzip/unzip, Lzh, Arj, or Scan will  lead to an archive being renamed.
  354.      These  problems  could   be  caused  by   a  virus,  corrupt  archive,
  355.      insufficient disk space, memory, etc.
  356.  
  357.      On the other  hand, if you  have elected _not_  to rename archives you
  358.      can do  your own error  checking when PKInsert  exits using errorlevel
  359.  
  360.      
  361.  
  362.      PKInsert Software Documentation                          Page 6  of 16
  363.  
  364.  
  365.      statements in a batch file.  The  complete list of PKInsert exit codes
  366.      is available in  appendix A.  PKInsert must  exit immediately after an
  367.      error  occurs  so  this  option   should  not  be  used  for  wildcard
  368.      processing.
  369.  
  370.                             Held Archive Rename Ext
  371.  
  372.      An archive will  be renamed (if rename  is enabled) to  .Hld if a file
  373.      measures 0  bytes, disk  space runs out,  or the  file is  not a valid
  374.      archive.  This provides a  method to hold archives  which did not fail
  375.      because of Pkzip/unzip, Lzh, Arj, or Scan for later review.
  376.  
  377.                                 Test Archive CRC
  378.  
  379.      Before handling  an archive,  PKInsert calls  Pkunzip, Lzh,  or Arj to
  380.      test the archive's integrity.  Nested  archives (Arcs within Arcs) are
  381.      also tested.
  382.  
  383.                              Corrupt Arc Rename Ext
  384.  
  385.      If you choose  to have archives  renamed, PKInsert will  use this file
  386.      extension to rename damaged zips.
  387.  
  388.                             Scan Archives for Virii
  389.  
  390.      PKInsert can use Scan.Exe from McAfee Associates to check archives for
  391.      viral infection.  Although archives are  expanded to check for viruses
  392.      it is unlikely you will 'catch' anything.  Virii which can be archived
  393.      attach themselves to executable code.   The files extracted are Scaned
  394.      and never executed.
  395.  
  396.                              Virused Arc Rename Ext
  397.  
  398.      When  a virus  is detected,  the  archive will  be renamed  using this
  399.      extension (provided renaming is enabled).
  400.  
  401.                              McAfee Assoc. SCAN Ver
  402.  
  403.      As of this writing the current  version of scan is 7.9V84.  This field
  404.      may be blank.   If you enter a  value here it will  be used in several
  405.      display  files where  mention  of Scan  is  made.  A  command  line or
  406.      environment parameter may be used to over-ride this value.
  407.  
  408.                             Number Taglines to Keep
  409.  
  410.      A  Tagline  is added  to  each archive  comment  containing PKInsert's
  411.      version number and your personalized information.  Taglines from other
  412.      systems may be kept and appended  to your archive comment.  This value
  413.      determines the maximum  number of past  Taglines to keep.   A value of
  414.      zero may be used to disable this feature.
  415.  
  416.      Note -   The  Test,  Scan, or  Delete  functions must  be  enabled for
  417.               PKInsert to pick up the Tagline information.
  418.  
  419.  
  420.      
  421.  
  422.      PKInsert Software Documentation                          Page 7  of 16
  423.  
  424.  
  425.                             Identification Tagline?
  426.  
  427.      Your  personalized Tagline.   Usually this  includes your  BBS's name,
  428.      phone number,  and special  system features.   As the  archive travels
  429.      through various systems, your tagline  will remain within the 'Tagline
  430.      History' (providing other systems keep previous Taglines).
  431.  
  432.      Once a system tagline  has been embedded into  the archive comment, it
  433.      is still possible to  alter it slightly.  PKInsert  does not take into
  434.      account case,  spacing, or  any non  alpha-numeric character.  Adding,
  435.      erasing, or  changing the  positions of  alpha-numeric characters will
  436.      cause your old tagline to be  used in the Tagline History bloc IF/WHEN
  437.      THE ARCHIVE IS RE-PROCESSED.
  438.  
  439.      Note -   A Tagline environment  variable may be  used to over-ride the
  440.               configuration file value.
  441.  
  442.               ie.  SET TAGLINE=7th Illusion /Mainstream Cyberspace/
  443.  
  444.                              Insert Archive Comment
  445.  
  446.      Archives created by Pkzip and Arj give us the opportunity to insert an
  447.      archive comment  screen (Lha does  not support  archive comments).  If
  448.      you  elect   not  to  insert   comments,  the   original  will  remain
  449.      undisturbed.
  450.  
  451.                               Delete Disclaimer(s)
  452.  
  453.      Certain  files,  such  as  !History.Dis  are  well  known  to  contain
  454.      advertisements or  disclaimer blurbs.  You  may elect  to delete these
  455.      files automatically  from each  archive PKInsert  processes.  A sample
  456.      list is included within this package  which you may edit from the next
  457.      configuration screen.
  458.  
  459.                              Add File(s) to Archive
  460.  
  461.      Same principle  as above,  except this  option lets  you add  files to
  462.      every archive.  I could go on for  hours on the reason not to use this
  463.      feature, including the fact that  you are polluting archives, but I'll
  464.      leave it to your better judgment.
  465.  
  466.                               Manage Pass/Fail Log
  467.  
  468.      Aside from loging results, PKInsert can also create one of two verbose
  469.      log files for every session.  These text files could then be displayed
  470.      to the user.  The names for these files may be specified later on.
  471.  
  472.      In order to properly link with  other utilities which use this type of
  473.      result  logging, special  handling is  necessary.  Before  appending a
  474.      Failure report, PKInsert  will rename the  Pass Log (if  it exists) to
  475.      the Fail Log name.  Therefore an  archive could pass a series of tests
  476.      before calling  PKInsert and  still keep  those results  when PKInsert
  477.      fails the archive.
  478.  
  479.  
  480.      
  481.  
  482.      PKInsert Software Documentation                          Page 8  of 16
  483.  
  484.  
  485.      If an  Extended Fail  Log already  exists, it  will be  used to append
  486.      PKInserts Pass or Fail  reports.  In this way  an archive could Fail a
  487.      series of tests, pass  PKInserts tests, and overall  you would be left
  488.      with one Fail log file.
  489.  
  490.                              Keep Result/Error Log
  491.  
  492.      This is a standard log file.  I would suggest you keep this option set
  493.      to (Y)es.  It's maintenance free thanks to the following option.
  494.  
  495.                              Max. Standard Log Size
  496.  
  497.      Before every  session PKInsert  checks the size  of it's  log.  If the
  498.      size exceeds this value (in Kbytes), a new one is started.
  499.  
  500.                              Nested Arc Array Size
  501.  
  502.      When PKInsert is hunting down archives within archives (add infinitum)
  503.      it monitors it's  depth or how  'nested' it is.   During this activity
  504.      PKInsert also keeps  track of file  names and locations  to know which
  505.      archives it has followed  to the end, and  which haven't been checked.
  506.      DOS machines being what  they are, you only  get so much memory.  This
  507.      value specifies at what point  PKInsert should start shedding portions
  508.      of itself to disk.  When it comes back from the 'deep' it will pick up
  509.      these pieces again and process the archives it missed.
  510.  
  511.      You can experiment and see what value  you prefer.  3 or 4 is probably
  512.      best.  You don't see  nesting past three very  often.  The larger this
  513.      value is, the more memory PKInsert will need.
  514.  
  515.      Note -   Reading swapped information may  take a few moments depending
  516.               on the  size of your  wildcard array, system  and disk access
  517.               speeds.
  518.  
  519.                             Arc Wildcard Array Size
  520.  
  521.      This value determines the maximum  number of archives a nested archive
  522.      may contain.   Theoretically the wildcard  array could be  set for 999
  523.      (max tested was 600 w/ nest 3),  but this would chew up tons of memory
  524.      and disk swapping would be excruciatingly slow.
  525.  
  526.      I've tried to  calculate the maximum  number of archives  a single Zip
  527.      could hold,  but I gave  up when I  hit 9  to the power  of 302.  That
  528.      value corresponded to a wildcard array of 101.
  529.  
  530.      Unfortunately, this value  also applies to the  wildcards you enter on
  531.      the command line.  Therefore (*.*) could not exceed the wildcard array
  532.      size.  An error level on exit is set if it does.
  533.  
  534.      Wildcards can be avoided easily.  See the 'Using PKInsert' section for
  535.      details.
  536.  
  537.  
  538.  
  539.  
  540.      
  541.  
  542.      PKInsert Software Documentation                          Page 9  of 16
  543.  
  544.  
  545.      ╔════════════════════════════════════════════════════════════════════╗
  546.      ║                         File Location Menu                         ║
  547.      ║                                                                    ║
  548.      ║   Ascii Editor            : C:\QEDIT\Q.EXE                         ║
  549.      ║                                                                    ║
  550.      ║   Standard Log File       : C:\PKINSERT\NODE-#.LOG                 ║
  551.      ║   Extended Pass Log File  : PCBPASS.TXT                            ║
  552.      ║   Extended Fail Log File  : PCBFAIL.TXT                            ║
  553.      ║                                                                    ║
  554.      ║   Virus Comment (Test)    : C:\PKINSERT\VIRUSTST.CMT               ║
  555.      ║   Virus Comment (Upload)  : C:\PKINSERT\VIRUSULD.CMT               ║
  556.      ║                                                                    ║
  557.      ║   Archive Comment File    : C:\PKINSERT\PKINSERT.CMT               ║
  558.      ║                                                                    ║
  559.      ║   Disclaimer(s) Del List  : C:\PKINSERT\PKINSDEL.LST               ║
  560.      ║   Add File(s) List        : C:\PKINSERT\PKINSADD.LST               ║
  561.      ║                                                                    ║
  562.      ╚═══ 12/04/91 ════════════════════════════════════════ 07:00:00am ═══╝
  563.  
  564.  
  565.                                   Ascii Editor
  566.  
  567.      Ascii editor file name  and path.  Placing the  cursor on a line which
  568.      can be edited, a bar will appear at the bottom of the screen informing
  569.      you to press F2 to edit the file.
  570.  
  571.                                Standard Log File
  572.  
  573.      File name and path of the Standard log file.
  574.  
  575.      Note -   Pound (#)  signs within  TEXT ENTRIES  are replaced  with the
  576.               current  node number  (except  in the  Tagline  field).  Node
  577.               numbers are  retrieved from  the Pcboard.Sys  and/or Door.Sys
  578.               file in  the current  directory.  If  none is  available, the
  579.               node number defaults to zero (0).
  580.  
  581.               If  you  wish to  retain  a  single configuration  file  in a
  582.               multi-user environment,  and do  not have  Pcboard.Sys and/or
  583.               Door.Sys available, you may  configure node numbers using the
  584.               (/N)ode parameter.
  585.  
  586.                         Extended Pass and Fail Log Files
  587.  
  588.      If the  'Manage Pass/Fail  Log' option  (1st configuration  screen) is
  589.      enabled, these file names are used to report processing results.
  590.  
  591.                        Virus Comment (Test) and (Upload)
  592.  
  593.      These two text files are used when PKInsert has created the Failed Log
  594.      File above and *only* in cases when a virus is found.
  595.  
  596.      The contents  of (Test)  are added  to the  Fail log  when the (/TEST)
  597.      parameter is used.   SysOps could use  this file to  advise users they
  598.      should leave a  Comment to the  SysOp a.s.a.p. so  this archive may be
  599.  
  600.      
  601.  
  602.      PKInsert Software Documentation                          Page 10 of 16
  603.  
  604.  
  605.      deleted.
  606.  
  607.      Similarly, the contents of (Upload) are added to the Fail log when the
  608.      (/UPLOAD) parameter  is used.   This second  text file  could advise a
  609.      user that  his system  might be  contaminated and  to take appropriate
  610.      steps before uploading again.
  611.  
  612.      If these  files do  not exist, they  will not  be used.   This way you
  613.      could have a comment for one function and not the other.
  614.  
  615.                               Archive Comment File
  616.  
  617.      This file should contain your archive comment (Ascii drawing).  Enable
  618.      this feature from the 'Configuration Options' menu.
  619.  
  620.                              Disclaimer(s) Del List
  621.  
  622.      This list is  used when the 'Delete  Disclaimer(s)' option is enabled.
  623.      A single  filespec should be  entered on each  line.  Archive contents
  624.      will be compared to this list and matching files will be deleted.
  625.  
  626.      Note -   Unfortunately Lha also scans this file for additional command
  627.               line  arguments, therefore  you should  NOT begin  a filespec
  628.               with (-) or (/).
  629.  
  630.                                 Add File(s) List
  631.  
  632.      Same principal as above, this file  should contain a list of filespecs
  633.      to insert in every archive.  Unlike  the delete list, you must include
  634.      paths for each file.
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.      
  661.  
  662.      PKInsert Software Documentation                          Page 11 of 16
  663.  
  664.  
  665.      ╔════════════════════════════════════════════════════════════════════╗
  666.      ║                    Command Line Parameters Menu                    ║
  667.      ║                                                                    ║
  668.      ║   McAfee Associates SCAN  : /a /nobreak /nomem /nopause /sub       ║
  669.      ║                                                                    ║
  670.      ║   Pkzip Del Disclaimer(s) : /bc:\ /dk                              ║
  671.      ║   Pkzip Add Files/Comment : /bc:\ /exzk                            ║
  672.      ║   Pkunzip Test Archive    : /t                                     ║
  673.      ║   Pkunzip Extract Files   : /xn /ojhsr                             ║
  674.      ║                                                                    ║
  675.      ║   Lha Del Disclaimer(s)   : d /wc:\                                ║
  676.      ║   Lha Add Files/Comment   : a /wc:\                                ║
  677.      ║   Lha Test Archive        : t /m1                                  ║
  678.      ║   Lha Extract Files       : e /m2                                  ║
  679.      ║                                                                    ║
  680.      ║   Arj Del Disclaimer(s)   : d /!@ /wc:\ /s1                        ║
  681.      ║   Arj Add Files/Comment   : a /!@ /wc:\ /s1 /m2 /e                 ║
  682.      ║   Arj Test Archive        : t                                      ║
  683.      ║   Arj Extract Files       : e /y                                   ║
  684.      ║                                                                    ║
  685.      ╚═══ 12/04/91 ════════════════════════════════════════ 07:00:00am ═══╝
  686.  
  687.  
  688.      These parameters are  passed by PKInsert when  shelling to third party
  689.      software.  If you encounter problems  with a new parameter set, please
  690.      drop me a line so I  can adjust PKInsert accordingly.  The options for
  691.      Scan  have been  tested  with version  7.9V84  and may  not  work with
  692.      earlier versions.
  693.  
  694.                           Pkzip/Lha/Arj Work File Path
  695.  
  696.      When Pkzip, Lha, or Arj handle an archive, they creates temporary work
  697.      files.  If you  have a ram-disk  installed, you should  edit the above
  698.      command line  parameters instructing  Pkzip, Lha,  and Arj  to use the
  699.      faster drive.
  700.  
  701.          ie.  Pkzip Del Disclaimer(s) : /bf:\ /dk
  702.               Pkzip Add Files/Comment : /bf:\ /exzk
  703.                                         ^^^^^
  704.               Lha Del Disclaimer(s)   : d /wf:\
  705.               Lha Add Files/Comment   : a /wf:\
  706.                                           ^^^^^
  707.               Arj Del Disclaimer(s)   : d /!@ /wf:\ /s1
  708.               Arj Add Files/Comment   : a /!@ /wf:\ /s1 /m2 /e
  709.                                               ^^^^^
  710.                                  Date Stamping
  711.  
  712.      PKZIP:   Using the default  (k) parameter, will  instruct Pkzip NOT to
  713.               change the  file date  of an  archive.  An  (o) will  set the
  714.               archive date  to the  oldest file  found within  the archive.
  715.               Eliminating this parameters will cause the archive date to be
  716.               updated to the current one.
  717.  
  718.  
  719.  
  720.      
  721.  
  722.      PKInsert Software Documentation                          Page 12 of 16
  723.  
  724.  
  725.          ie.  Pkzip Del Disclaimer(s) : /bf:\ /do
  726.               Pkzip Add Files/Comment : /bf:\ /exzo
  727.                                               ^^^^^
  728.      LHA:     Lha will  not change an  archive's date  unless an additional
  729.               parameter is used.  The (/t1) command instructs Lha to update
  730.               the archive's date to the newest file within.
  731.  
  732.          ie.  Lha Del Disclaimer(s)   : d /wf:\ /t1
  733.               Lha Add Files/Comment   : a /wf:\ /t1
  734.                                                 ^^^
  735.      ARJ:     The default switch  (/s1) will instruct Arj  to keep the same
  736.               file date when updating the archive.  Eliminating this switch
  737.               will stamp the file with the current system date.  Using (/s)
  738.               instead, will  set the archive's  date to that  of the newest
  739.               file within.
  740.  
  741.          ie.  Arj Del Disclaimer(s)   : d /!@ /wc:\ /s
  742.               Arj Add Files/Comment   : a /!@ /wc:\ /s /m2 /e
  743.                                                     ^^
  744.      Optionally you may refer to the appropriate archiver manuals to select
  745.      alternative compression speeds/efficiency, file sorts, filters, etc.
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.      
  781.  
  782.      PKInsert Software Documentation                          Page 13 of 16
  783.  
  784.  
  785.                                  Using PKInsert
  786.  
  787.      Using PKInsert is fairly simple.  From the command line or environment
  788.      variable make  sure PKInsert  knows where  to find  it's configuration
  789.      file.  Then call PKInsert passing it file names (or wildcards).
  790.  
  791.      The parameters,  file names, etc.  may be  in any order  and any valid
  792.      compression standard.   You could  even enter  file names  through the
  793.      environment variable if you wanted.  Some examples follow.
  794.  
  795.          ie.  SET PKINSERT=/cD:\PKInsert\PKInsert.Cfg /s7.9V84
  796.               PKINSERT.EXE Abc.Zip
  797.  
  798.               SET PKINSERT=/n1 /s7.8v82
  799.               PKINSERT %1 /cD:\PKInsert\PKInsert.Cfg *.Exe Abc-?.New
  800.  
  801.               SET PKINSERT=/cC:\PKInsert\System.Cfg
  802.               PKINSERT *.Zip *.Exe Abc.Bak New.Arj *.Lzh
  803.  
  804.               SET PKINSERT=/n1 /sVer82 Archive.* /c\Arc\Config.Pki
  805.               PKINSERT
  806.  
  807.               PKINSERT /cThisDir.Cnf Test.Hld
  808.  
  809.      Undoubtedly most users will want  to test complete directories at some
  810.      point, which may exceed the Wildcard Array size you selected.  In this
  811.      case, an advanced Dos command line could be used.
  812.  
  813.          ie.  LOOP.BAT
  814.               ~~~~~~~~
  815.               FOR %%A IN (Archive.*) DO PKINSERT %%A
  816.               or
  817.               FOR %%A IN (A*.Zip Dbl*.* Abc-?.Arj) DO PKINSERT %%A
  818.  
  819.      Any  filename preceded  with  an AT  (@)  symbol will  be  expected to
  820.      contain a list of  files to process.  Each  file specification in this
  821.      list must occupy a separate line.  Wildcarding is accepted.
  822.  
  823.          ie.  Files.Lst
  824.               ~~~~~~~~~
  825.               D:\Arc\*.Arj
  826.               Archive.*
  827.               E:\Main\Files\Backup.B??
  828.               \Work\A*.Tmp
  829.  
  830.          You may also use a combination of directory pipes.
  831.  
  832.          ie.  C:\> Dir D:\Arc >Files.Lst
  833.               C:\> Dir E:\Main\Files\*.* >>Files.Lst
  834.  
  835.          Instead  of  entering  redundant  directory  information  you  can
  836.          instruct PKInsert to change drives  and directories.  Use the (Cd)
  837.          command  followed by  a space,  or  back-slash, and  the directory
  838.          name.
  839.  
  840.      
  841.  
  842.      PKInsert Software Documentation                          Page 14 of 16
  843.  
  844.  
  845.  
  846.          ie.  Files.Lst
  847.               ~~~~~~~~~
  848.               Archive.Zip
  849.               Cd\Arc
  850.               Archive.Arj
  851.               Cd E:\Main\Files
  852.               Good*.*
  853.               Bad*.Old
  854.               Ugly*.$$$
  855.               Cd\C:\Temp
  856.               Backup.Z??
  857.  
  858.          These techniques may be used conjunction for greatest versatility.
  859.  
  860.          Note -    Normal  array size  boundaries  apply ONLY  to wildcards
  861.                    within this  list.  There is  NO LIMIT to  the number of
  862.                    filespecs contained  in the  file list.   If you  have a
  863.                    directory of several  thousand archives you  could use a
  864.                    command sequence along these lines:
  865.  
  866.                    C:\> Dir J:\Uploads\*.* >Files.Lst
  867.                    C:\> PKInsert @*.Lst
  868.  
  869.                    Wildcarding is also acceptable for filelist names.
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.      
  901.  
  902.      PKInsert Software Documentation                          Page 15 of 16
  903.  
  904.  
  905.                                    Appendix A
  906.                               PKInsert Exit Codes
  907.  
  908.           Virus Scan
  909.  
  910.      10   One or More Virii Found
  911.      11   Abnormal Termination
  912.           (Usually Lack of Memory)
  913.  
  914.           Pkunzip
  915.  
  916.      20   Zip Failed CRC Check
  917.      21   Error in Zip File
  918.      22   Insufficient Memory
  919.      23   Archive File Missing
  920.      24   Illegal Parameters Specified
  921.      25   No Files in Archive to Test
  922.      26   Disk Full
  923.      27   Unexpected EOF in Zip
  924.  
  925.           Pkzip
  926.  
  927.      40   Bad File Name or File Specification
  928.      41   Error in Zip File
  929.      42   Insufficient Memory
  930.      43   No Files Found To Delete
  931.      44   File Not Found
  932.      45   Disk Full
  933.      46   Archive Is Read-Only - Cannot Modify
  934.      47   Bad or Illegal Parameters
  935.      48   Too Many Files in Zip
  936.  
  937.           Lha
  938.  
  939.      50  CRC Error or Insufficient Disk Space
  940.      51  Temporary Archive Write Failed
  941.  
  942.          Arj
  943.  
  944.      60  Fatal Error
  945.      61  Header or File CRC Error
  946.      62  ARJ-SECURITY Error or Attempt to Modify
  947.      63  Insufficient Disk Space or Write Error
  948.      64  Unable to Open Archive
  949.      65  Bad or Missing Parameters
  950.      66  Insufficient Memory
  951.  
  952.           PKInsert
  953.  
  954.      100  Incorrect Parameters
  955.      101  Configuration File Missing
  956.      103  Unable To Create Work Directory
  957.      104  Invalid Path or No Matching Files
  958.      105  Insufficient Drive Space Available
  959.  
  960.      
  961.  
  962.      PKInsert Software Documentation                          Page 16 of 16
  963.  
  964.  
  965.      106  Unable To Remove Work Directory
  966.      107  Insufficient DOS File Handles
  967.      108  Network Delay Timed-Out
  968.      109  Unable to Remove Nest Directories
  969.      110  Illegal Configuration File Value
  970.      111  Illegal Compression Method Used
  971.      112  Zero Byte File
  972.      113  Unknown Configuration File Format
  973.      114  Unable to Locate File; Pkzip/Unzip or Scan
  974.      200  Wildcard Array Exceeded
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002.  
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020.      
  1021.